/*
 * Copyright:  2018 smarabbit studio.
 *
 *  Licensed under the Confluent Community License; you may not use this file
 *  except in compliance with the License.  You may obtain a copy of the License at
 *
 *  http://www.confluent.io/confluent-community-license
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 *  WARRANTIES OF ANY KIND, either express or implied.  See the License for the
 *  specific language governing permissions and limitations under the License.
 *
 *  @作   者： 黄开晖 (117227773@qq.com)
 *  @日   期:  2021年5月23日
 */
package com.massyframework.beanskin;

import com.massyframework.beanskin.util.version.Version;
import com.massyframework.beanskin.util.version.VersionRange;

/**
 * 模块标识符,用于确定模块的唯一性。
 * <p>
 * 它包括：
 * <ul>
 *     <li>groupId, 模块所属的组织、产品名称</li>
 *     <li>moduleId, 在所属group中的模块名称</li>
 *     <li>version, 版本号</li>
 * </ul>
 * @author huangkh
 */
public interface ModuleIdentifier extends Comparable<ModuleIdentifier>{
	
	static final String COLON = ":";
	
	/**
	 * 所属组编号
	 * @return {@link String}
	 */
	String getGroupId();

	/**
	 * 名称
	 * @return {@link String}
	 */
	String getModuleId();
	
	/**
	 * 版本
	 * @return {@link Version}
	 */
	Version getVersion();
	
	/**
	 * 是否等同{@code groupId}和{@code moduleId}
	 * @param groupId {@link String},组编号
	 * @param moduleId {@link String},模块编号
	 * @return {@link boolean},返回{@code true}表示相同，否则返回{@code false}
	 */
	default boolean isEquals(String groupId, String moduleId) {
		return this.getGroupId().equals(groupId) &&
				this.getModuleId().equals(moduleId);
	}
	
	/**
	 * 是否等同{@code groupId}和{@code moduleId}
	 * @param groupId {@link String},组编号
	 * @param moduleId {@link String},模块编号
	 * @param version {@link String}，版本号
	 * @return {@link boolean},返回{@code true}表示相同，否则返回{@code false}
	 */
	default boolean isEquals(String groupId, String moduleId, String version) {
		return this.getGroupId().equals(groupId) &&
				this.getModuleId().equals(moduleId) &&
					this.getVersion().toString().equals(version);
	}
	
	/**
	 * 是否等同{@code groupId}和{@code moduleId}
	 * @param groupId {@link String},组编号
	 * @param moduleId {@link String},模块编号
	 * @param version {@link Version}，版本号
	 * @return {@link boolean},返回{@code true}表示相同，否则返回{@code false}
	 */
	default boolean isEquals(String groupId, String moduleId, Version version) {
		return this.getGroupId().equals(groupId) &&
				this.getModuleId().equals(moduleId) &&
					this.getVersion().equals(version);
	}
	
	/**
	 * 是否等同{@code groupId}和{@code moduleId}，并且版本处于{@code versionRange}范围内
	 * @param groupId {@link String},组编号
	 * @param moduleId {@link String},模块编号
	 * @param versionRange {@link VersionRange},版本范围
	 * @return  {@link boolean},返回{@code true}表示是，否则返回{@code false}
	 */
	default boolean isInclude(String groupId, String moduleId, VersionRange versionRange) {
		return this.getGroupId().equals(groupId) &&
				this.getModuleId().equals(moduleId) &&
					versionRange.includes(this.getVersion());
	}
	
	/**
	 * 是否为内核装配件
	 * @return {@link boolean},返回{@code true}表示是，否则返回{@code false}
	 */
	default boolean isKernelAssembly() {
		return this.getGroupId().equals("com.massyframework.beanskin") &&
				this.getModuleId().equals("beanskin-runtime-core");
	}
	
	/**
	 * 转换为唯一标识符
	 * @return {@link String}
	 */
	default String toIdentifier() {
		return this.getGroupId().concat(COLON)
				.concat(this.getModuleId()).concat(COLON).concat(this.getVersion().toString());
	}
}
